Welcome

Welcome to Voyager. If you're reading this, you may be trying to figure out just what Voyager is and whether it is something you need, or you have already decided your data management could use some attention and Voyager is the perfect tool to get things in order. Regardless of type of user you are, this document will answer your questions and help you become a successful user (and lover) of Voyager. If you already have a copy of Voyager and want to get started quickly, jump directly to the User Guide section. Otherwise keep reading to find out what exactly Voyager is and what it can do for you.

What is Voyager?

Voyager is a powerful search solution that combines a comprehensive knowledge of geospatial data with web style search.

With Voyager, users can easily find GIS datasets, images, maps, layers and other documents (Word, PowerPoint, PDF) stored on their desktop, servers or across the web.

By implementing Voyager, organizations can boost their bottom line and improve productivity by reducing time spent searching for and gathering information. Workers save significant time by not having to recreate or purchase content that already exists but which could not be located.

How Voyager Works

Voyager runs as either a desktop application or server based solution, accessed through any web browser. In both configurations Voyager fits within existing workflows and IT environments through an easy to install and easy to configure interface.

Voyager does not require any upfront investment of time spent loading data into the system. Users quickly install Voyager, point it at local data, data on servers, or data on the web, and start the discovery process. Without requiring the existence of metadata or system downtime, Voyager builds a comprehensive catalog of resources regardless of where data is stored. The catalog created by Voyager does not create a copy of the data, it simply finds it, makes a record of what it finds, and displays everything in a clean, easy to use interface.

Once the catalog is created users can search for content using text, spatial and filtered queries.

Return on Investment

So, why use Voyager other than to find out where data is?  Voyager’s easy to use solution provides measurable value to all aspects of an organization's GIS investment.

High-quality search helps workers focus on their jobs. Voyager gives users more time to analyze information, make better decisions and create useful new content, while saving money by minimizing wasted time looking for data.

Voyager's ease of use and modern web application helps users find content they need quickly through a variety of search criteria and aids in exploring the relationships between maps, layers and their corresponding datasets.

Publish and promote Spatial Data Infrastructure. Voyager helps organizations publish and promote their spatial data infrastructure on the web. This promotes reusable content and resource sharing.  By using Voyager, organizations can meet their data sharing requirements with one easy to use solution.

Voyager's auditing capabilities make it easy to improve the quality of data. Voyager aids in identifying and fixing many common problems, including: items that are missing metadata or do not contain spatial references, duplicate datasets, maps that contain broken links to data, as well as identifying datasets that are used most often. Once patterns are identified and datasets are found, Voyager can be used to clean up data by removing duplicates, setting correct spatial reference, creating metadata and a variety of other processing tasks.

Voyager Anatomy

Server Framework

Core system components:

Client Applications

With Voyager You Can

Voyager’s universal search openly integrates data from anywhere in the organization using a single search solution. With Voyager you can:

• Quickly index GIS data, maps and office formats (PDF, Word, Excel etc.) on your own computer or across enterprise servers
• Search for data and maps using full text and spatial queries as easily as you search the web
• Immediately preview the results of your search through thumbnails and instantly use your selected items in a variety of GIS applications
• Use search results in daily tasks such as adding data to ArcMap, extracting data to share with colleagues or use in the field, editing metadata, converting search results to KML, etc..

Voyager allows you to index and then search all of your GIS resources whether they are on your local file system, network shares or across the Internet. Once content is indexed, voyager streamlines a variety of daily tasks.

For people who are not familiar with specialized GIS software or simply have data in a variety of places, Voyager is the perfect solution for providing information on maps, datasets and GIS services when you want it – right on your desktop. Voyager improves productivity by providing easy access to all of your GIS resources.

Voyager makes publishing a searchable index of available GIS resources within a team, across an organization or over the Internet as easy as a single step. With Voyager you can quickly index and publish the maps and datasets that you wish to share. Voyager serves as a GIS portal.

Voyager creates a rich, searchable index by crawling your datasets, layers, maps and GIS services. It is because of this that Voyager surpasses traditional GIS portals by offering a richer index by including items which traditional portals ignore such as map layers and map documents. Voyager's modern search interface is easy to use and makes searching your organization’s GIS resources as easy as searching the web.

Voyager is a perfect data auditing solution. By crawling and indexing data Voyager is able to provide answers to many questions you may ask:

• How many datasets do I have?
• How many duplicate datasets are there?
• Which datasets are large? Which are small?
• What spatial references am I using?
• Which datasets are most commonly used in my maps?
• Which resources are slow to access? Slow to draw?

All of these questions can be answered within the search window. Searches can be saved and then re-run or shared with other users. Search results can also be viewed as RSS feeds enabling you to get updates as changes occur.

Collectively Search all Content

Voyager provides the ability to search all geo-spatial content in an enterprise through a single solution. Although content sources might reside in different locations such as on a desktop, network file server, corporate database servers or web servers running internally or on the World Wide Web, they appear as a single integrated set of search results.

Voyager’s universal search:

Publish and Promote your Spatial Data Infrastructure

Voyager provides a framework for publishing both metadata and spatial data along with streamlined data distribution tools that allow users to collaborate and utilize data in an efficient and flexible way.

With Voyager creating a portal to promote your Spatial Data Infrastructure is as easy as three steps:

1. Install Voyager and index your data. This creates a comprehensive catalog of the information that your organization already has, whether items contain metadata or not.
2. Audit your system and clean up your resources. Voyager’s auditing capabilities allow you to clean things up before sharing them with others. For example you can locate items without metadata, and create metadata where necessary, find and eliminate duplicate data, fix broken data links and locate items without a spatial reference.
3. Publish your catalog for others to use. Publish the Voyager catalog online by simply sharing its URL. With Voyager you can create saved searches to highlight specific content, default views for different user needs, make RSS feeds available to keep people up to date and utilize other features to help people explore and download your data.

Streamline Processes and Deliver Data

Voyager provides a processing framework that helps streamline tasks. The framework allows users to select items from the index and perform common tasks such as downloading data or converting data to KML as easily as using an online music store to find and download MP3s.

Product Information

Product Versions

See also: http://voyagergis.com/products

Voyager is available in four license options: Free, Analyst, Workgroup and Enterprise.

Voyager Free

This no-cost license is for becoming familiar with how Voyager works. This license is limited to 5,000 records and can only be viewed on a single computer (laptop or workstation install). Support will be provided via web-based discussion forum.

Voyager Analyst

Analyst is for improving personal productivity and auditing data. The index size is limited to 1 million records and the software is restricted to single-user access (laptop or workstation install).This license is ideal for small organizations with a single GIS analyst or multiple analysts that work independently.  Voyager’s Ask Us Anything technical support is available to assist users with installation, licensing, configuration and general technical issues that users may encounter.

Voyager Workgroup

Workgroup is an entry-level server based install. Voyager Workgroup can be used to share data across a team of people or an entire organization. This license does not have a limit on the number of records and is based on the number of concurrently connected users (per-user license).  Voyager’s Ask Us Anything technical support is available to assist users with installation, licensing, configuration and general technical issues that users may encounter.

Voyager Enterprise

Enterprise is ideal for organizations with either a large number of users or with a need for more control over their configuration; including the look-and-feel, security access, load balancing and server-side processing. Voyager Enterprise supports both an unlimited number of records and an unlimited number of concurrent users.  Voyager’s Ask Us Anything technical support is available to assist users with installation, licensing, configuration and general technical issues that users may encounter.

Product Comparison Matrix

Product Feature Descriptions

Network Accessible

Accessibility determines if Voyager can be accessed over a network. Voyager Free and Analyst run in single-user mode and may only be used on the machine running Voyager (localhost only). Voyager Workgroup and Enterprise run in a server environment allowing remote access.

Maximum Records Indexed

Voyager Free and Analyst have a limit on the number of records that can be indexed. Once this limit is reached Voyager will display a message and will not index new data. There are no record limits with Voyager Workgroup or Enterprise licenses.

Number of Concurrent Users

This indicates total number of people, or other computer services, with simultaneous connections to the Voyager Service. Voyager Free and Analyst allow a single connection. Voyager Workgroup is licensed per connection and Enterprise has no limit on the number of concurrent users.

Client-Side Processing (Voyager Desktop Application)

The ability to run search results through a process on the user's own computer. For example, selecting search results and running each item in the result set through geoprocessing tasks using the ESRI software installed on a user’s desktop computer.

Client--side processing is performed using the Voyager Desktop application.

Server-Side Processing

Server-side processing allows users to process search results without having any specific software installed on their desktop computer. Users can access Voyager using a web browser, search for data, and then use Voyager’s server-side processing framework to execute tasks on the server. Processing results can be downloaded and used locally.

Basic Authentication

Voyager includes an internal authentication system and authorization matrix.  In this system users can be added to roles that can perform actions in Voyager. For example users can be given rights to view or manage Voyager.

Configurable User Authorization

A flexible configuration allows for more defined role based access. Users can be added and assigned specific roles: view index, administration rights, limit access to certain data, run processes, etc.

Pluggable Windows/LDAP Authentication

Voyager is integrated with existing authentication systems such as Lightweight Directory Access Protocol (LDAP) and Windows Authentication.

Custom Logo / Color Scheme

Custom logos and color schemes can be used to integrate Voyager with your organization’s visual standards.

Customized Interface / Direct Access to Index

Programmatic access to the Voyager web service allows direct access to the Voyager index. Designers and web developers can use this feature to build customized web applications as well as integrate Voyager with other systems.

Federated Search

Users can simultaneously search multiple Voyager instances. Federated Search helps organizations link multiple Voyager installations and indices to provide a single comprehensive view of their entire spatial data infrastructure.

Distributed Data Discovery

Use multiple computers to manage discovery process. This feature allows organizations with considerable processing needs to run tasks across many machines.  Job scheduling can be used to control Distributed Data Discovery so that it only runs at times when computers would otherwise be idle.

Index Replication (Load Balancing)

To increase performance and availability, identical copies of the Voyager index can run in parallel.

Index Sharding

Sharding is useful for an extremely large number of records (>50 million). Voyager can be configured to split the index across multiple computers while still maintaining the appearance and usability of a single index.

Web Application Clustering (Load Balancing)

A load balanced configuration where Voyager runs in a clustered application server. In this configuration a group of servers running Voyager’s application appears as if it were a single server. To balance load, Voyager distributes requests to different nodes within the server cluster, optimizing system performance and resulting in higher availability and scalability – a necessary option in large-scale enterprise, web-based configurations.

Software Maintenance

The software maintenance program provides a number of technology and business benefits to you and your organization. Keeping your technology investment up-to-date with the latest technology updates and software releases and simplifying your maintenance and support budgeting process with predictable annual program fees are just two of the advantages.

Software Updates

Automatic software updates are released in the form of fixes, service packs and full releases. When a software update is available, it is delivered to customers with current software maintenance contracts via internet download.

Technical Support

Voyager’s Ask Us Anything technical support is available to assist users with installation, licensing, configuration and general technical issues that users may encounter. Technical support is available regardless of where you are working in the world--\- ensuring that workers are covered with the support they need when they need it.

Software Maintenance subscriptions include 12 months of technical support for one authorized caller. Organizations must provide the name of the authorized caller to Voyager Technical Support. Organizations can change the authorized caller at any time. If an organization does not notify Voyager with the name of the authorized caller, the first person to call Voyager to request technical support will become the authorized caller.

Cost

Software Maintenance is 20% of the software list price. The first 12 months of maintenance are complimentary with each software purchase.

Getting Started

This section shows you how to quickly get started with Voyager, including information on system requirements, and installation and setup procedures.

System Requirements

Voyager requires the Esri ArcGIS™ software platform to index Esri data formats (feature classes, layer files, ArcMap documents, etc.). To install Voyager a computer must meet the following requirements:

Operating System:

• Any edition of Windows XP, Windows Vista, Windows 7 or Windows Server

Indexing Esri formats:

• A valid license of any ArcGIS™ 9.3, 9.3.1, 10.0, 10.1 software product including ArcGIS Desktop™
• Service packs are not required but recommended
• ArcGIS™ 9.3, 9.3.1 .NET installation option must be enabled

Using Voyager without Esri Software:

For those that do not have access to Esri software, Voyager is capable of indexing many formats without having to install any Esri product.  Support formats include, but are not limited to:

• Shapefile
• DTED
• RPF
• NITF
• TIFF
• MrSID
• JPEG (spatial and geotagged photos)
• GPS eXchange Format (GPX)
• PDF - both standard pdf documents and geo-pdf
• Microsoft Power Point
• Microsoft Word

Voyager Desktop Software Requirement

Voyager Desktop is a lightweight client to the Voyager application server. The Desktop application can be used as an alternative to a standard web browser.

Operating System:

• Any edition of Windows XP, Windows Vista or Windows Server

ArcGIS Desktop Integration:

Voyager Desktop includes productivity tools that integrate with ArcGIS Desktop. To leverage these you must have the following installed:

• A valid license of any ArcGIS™ 9.3, 9.3.1, 10.0, 10.1 software product including ArcGIS Desktop™
• Service packs are not required but recommended
• ArcGIS™ 9.3, 9.3.1 .NET installation option must be enabled

Installation Guide

This guide will walk though how to get Voyager installed and running. If you already have Voyager installed, see Upgrading to 1.2.3

Download Voyager

Download Voyager from http://VoyagerGIS.com/

For a complete list of downloads, check: http://VoyagerGIS.com/downloads

Run Installer

Running the Installation Program

To begin the installation, navigate to the installer executable file and double-click it.

Double click on Voyager_with_jre_XXX.exe (where XXX is the software version number). The installation wizard will begin to guide you through the necessary steps.

Note: you may receive a windows security warning specifying that the application’s publisher is Unknown. If so please ignore.

Welcome and Select Installation Directory

If a previous version of Voyager has been detected on your machine, the Welcome screen gives you the option to install into the existing directory or to a different directory. If you choose to install into a different directory, you will have the ability to choose your installation location from the upcoming Select Destination Directory screen, otherwise it will default to the current Voyager install directory.

Accepting the License Agreement

License Agreement is displayed – read the terms of the Licensing Agreement and check the first radio button to indicate agreement.

Choose Installation Location

After accepting the license the next step of the install is to select a destination directory. It is recommended that you accept the default.

Periodically, Voyager will write information to the installation location and therefore it is important that you have disk space available at this location. The amount of disk space is dependent on the size of the index that is built.

Voyager Start Options

A dialog is displayed to specify the Voyager start options; accept the defaults unless a different option is desired.

File Associations

The File Associations dialog is displayed; accept the default value.

File Extraction Progress

The progress dialog is displayed to indicate the progress of extracting and installing the Voyager software.

Launch Options

The progress dialog concludes and a few configuration and launch options are presented. Choose whether:

• Voyager should be launched after concluding the installation process
• You would like a link to Voyager on the desktop
• The installer should register the ArcMap Toolbar (the toolbar includes ArcMap integration features such as searching the Voyager index from within ArcMap and dragging and dropping items from Voyager into ArcMap)

Voyager Tools Installer

If the option to register the Voyager ArcMap Toolbar was selected, the Voyager Tools Installer is displayed.  Click "Install" to finish installing the toolbar.

When the ArcMap Toolbar has been installed, you have the option to launch ArcMap by clicking the "Open ArcMap" link. Otherwise click "OK", and the installation is complete.

For more information see ArcMap Toolbar

Installation Complete - Voyager Launches

When installation is complete, you'll see the Voyager Splash Screen, then configuration wizard.

Setup Wizard

The setup wizard will take you through each step of the configuration process

Step 1. License

Software Authorization

Software authorization is used to unlock and register your copy of Voyager.

Free License

To get a free license for Voyager, log into http://voyagergis.com/licenses (create a new account if you don't have one). Enter your Machine Key shown on the configuration wizard and Voyager will generate a new license for you.  Paste the license key into text box.

Authorization using an existing license

If you already have a license, paste the license key supplied by Voyager into the text box.

Click "Install License" to allow Voyager to validate the supplied license key. After license validation, Voyager displays the success message and indicates the owner of the license.

For more information on licenses, see: Manage Licenses

Step 2. Locations

Configuring Discovery Locations

The next step in the process requires specifying a folder location that Voyager will explore to look for data and documents.

Clicking on the Browse button opens a dialog where you can browse your file system for directories to index.

Once a folder is selected, clicking on the Add Location button will add it to the list of locations to be indexed.

Web Services

In addition to adding file-based locations, you could also choose to index WMS or ArcGIS Server web services. To add a Web Service location, select the Web Service tab and enter the URL. Specify whether it is WMS or AGS web service, and click Add Service.

Open Geospatial Consortium Catalog Services (CSW)

CSW compliant servers can be indexed by adding the server URLs to Voyager’s list of Discovery Locations. To add a service enter the URL, select the CSW server software used to publish the service and then press ‘add’. Note that a few example services are provided.

For more info, see: Locations

Step 3. Discovery

Start Indexing Data

After adding discovery locations and clicking next the indexing process will begin. After viewing progress you can click on Next to proceed.

See Discovery Status for more information on Indexing and Queue status.

Step 4. Learn

Setup Finished

Once configuration is finished you can click “Next” to view the index.

View Index

The final step is to View the index. It may take a few minutes for items to appear.

User Guide

This section gives an overview of the Voyager application. It describes the user interface components, how to search and view your data, and various processes that can be run to help speed up day-to-day tasks.

User Interface

The Voyager display is composed of a few basic components, including a textual search box, a toolbar containing some helpful menus, a search results area, an overview map, and filters, all of which will be explained in this section.

Search Box

The search box is used for text queries and is an easy way to find items in the index.  For more information on how to search using the text search box, go to Query Syntax.

Menu Toolbar

The toolbar contains the navigational and functional menus within Voyager: Home, Sort, View, Tools. It also displays the number of results in the current search and provides the ability to navigate through the results pages.

Home Menu

The Home menu has four options: Voyager Search, Saved Searches, [Lists |DOC:Working with Lists]and Processing. Voyager Search clears any previous search, brings the interface to the main page and shows all indexed data. Saved Searches takes you to a list of previously saved searches.  Lists displays the various lists you have created.  Processing displays a history of the process tasks that have been run.

Sort Menu

The Sort menu has a list of sorting options so you can see results in the way that makes most sense to you.  This list is configurable via the Configure Sort dialog and also contains an option for reversing the direction of the search results.

View Menu

The View menu enables a user to determine how they want the data to be displayed. There are five view options: Summary, Grid, Map, [Table |DOC:Table View]and Report The View tab also allows a user to determine and set configurations for Filters, Display, Table, Reports, and Sort.

Tools Menu

The Tools menu provides several things a user can do with the data that Voyager has discovered, including:Save This Search, Open RSS Feed, Open Results With, Process Results, Add Results to List, Generate Report, and Export Result List.

Search Results

Below the toolbar, the search results are displayed in the type of View the user has chosen (Summary, Grid, Map, Table, Report).  In this case, the results are displayed in the Grid View.

Overview Map

The Overview Map to the right of Search Results displays the extents of the data on a map.

Filters

Below the Overview Map is a list of Filters, which are used to refine a search. The default filters are: Type, Subtype, Format, Geometry Type, Keywords, Properties, Author, Spatial Reference, Version, Theme, File Extension, and Location, but they are configurable. The Show Inverse Option filters on the opposite value of any existing filter.

Depending on the user's permission level, Admin Options may be available from the Filters section. The following actions can be taken on the current set of results:

• Remove from the index, with the option of also deleting the corresponding thumbnails, metadata, and layer files
• Add results to the discovery queue, which re-indexes the items immediately
• Show the underlying query

Searching for Data

Searching for data can be done in different ways. Voyager provides filters, which can be used to narrow your set of results to just the data you are looking for. Another option is to do a textual search, using the search box. Once you have found what you are looking for, the results can be sorted by different fields.

Query Syntax

By default Voyager searches over all text (including metadata) for matching items. Results that match the title or path are ranked above results matching any other text. To customize the default field weights, see Query Settings

In addition to the default behavior, Voyager supports explicit operators and field selection

Operators

OR

The OR operator is the default search operator. This means that if there is no operator between two terms in a search, the OR operator is used. The OR operator links two terms and finds a matching record if either of the terms exist in a record.

For example, to search for records that contain either "Florida highways" or just "highways" use the query:

or

AND

The AND operator matches records where both terms exist anywhere in the text of a single record.

For example, to search for records that contain "rivers" and "lakes" use the query:

Fields

Voyager supports fielded data. When performing a search you can either specify a field name, or use the default search which uses many fields.
You can search any field by typing the field name in lowercase followed by a colon ":" and then the term you are looking for.
Searching by field names only produces results that match the particular field specified.

For example, to search for  any records with "Rivers" in the name field and "Florida" in the path field, use the query:

Note: The field is only valid for the term that it directly precedes, so the query

Will only find "major" in the name field. It will find "cities" using the default search which uses many fields.

To search for 2 or more terms in a field name, quotes around the text are required. For example, to search the name field for "major cities", use the query:

Search by path

Paths in voyager can either be searched for using the standard field selection operator ":", or a special "=" operator that matches folders explicitly.

Using the standard "path:" syntax, the query is looking for words in the path. For example:

Will return items with "Desktop" in the path.

Using the "=" operator will find files explicitly in a folder. For example:

Will find all results under this folder. Aditionally, the path= syntax triggers a special Path Navigation UI.

Wildcards

Voyager supports single and multiple character wildcard searches within single terms.

To perform a single character wildcard search use the "?" symbol.

To perform a multiple character wildcard search use the "*" symbol.

The single character wildcard search looks for terms that match that with the single character replaced. For example, to search for "text" or "test" you can use the search

Multiple character wildcard searches looks for 0 or more characters. For example, to search for counties or countries, you can use the search:

Escaping Special Characters

Voyager supports escaping special characters that are part of the query syntax. The current list special characters are:

To escape these character use the \ before the character. For example to search for (1+1):2 use the query:

Lucene Query Syntax

Text searches in Voyager are based on Lucene style syntax. So users can use operators, specific field names or wildcards to produce the results they require.

For more information about Lucene style syntax please refer to the following link: [http://lucene.apache.org/core/3_6_0/queryparsersyntax.html]

Sorting Results

The Sort tab has a list of sorting options so you can see results in the way that makes most sense to you.  This list is configurable via the Configure Sort dialog and also contains an option for reversing the direction of the search results.

Path Navigation

Path Navigation allows filtering simply by clicking any of the folder or sub-folder locations from the path on the Detail Page.

Search Result Options

Voyager provides options to a user when a thumbnail of an individual search result is clicked in the Summary, Grid or Map Views.  These options are:  Show Detail Page, DOC123:Show Preview, DOC123:Show Metadata, Open With, Locate on Disk, Process, Add to List, Remove From List, Extent, and Exclude Item.

Detail Page

The Detail Page reveals many details specific to this individual search result. By default, the details displayed include basic attributes like the name, path, theme, place, etc. What information is displayed can be configured via the Configure Display option under the View menu.

The detail page also shows links or relationships between the item and any other items in the index.  For example, if the dataset is used in an MXD or Layer File, the MXDs or Layer Files will be displayed as links in the "USED BY" section. 

Conversely, MXDs and Layer Files display the items within them in a tree structure, so users can see which Feature Layers and datasets are used in the document and can explore them directly from the DATA section or via the links in the MXD structure.

The relationships between items in a database are also captured and displayed. For example, databases show links to all of the items within them. Feature datasets show which database they are in, as well as the datasets they contain. And datasets have links to their database and feature datasets.

Show Preview

Shows a larger, more detailed view of the dataset.

Show Metadata

Displays the item's metadata using the style selected from the dropdown menu. Custom style sheets can also be added to this list.

Open With

The Open With option allows the user to open the individual search result in a variety of desktop applications, including ArcGIS desktop applications, KML viewer, or the Window Default Application.

Locate on Disk

Opens Windows Explorer and navigates to the individual search result on disk.

Process

This option opens the choices for processing the individual search result on desktop or server. The process choices are Clip and Ship, Convert to KML, Create Default Metadata, Copy Data or Mosaic. For more detailed information about the processes, see the Processing section.

Add to List

This gives the user the ability to add the individual search result to either a new list or an existing list.

For more information about lists: Working with Lists

Remove From List

This gives the user the option to remove the individual search result from a list.

For more information about lists: Working with Lists

Extent

This gives the user the options to:

• Zoom to Extent \-Zooms the map into the extent of this item
• Query Within Extent - Performs a spatial query and returns all items whose extent falls completely within the current item's extent.
• Query Extent Intersection - Performs a spatial query and returns all items whose extent intersects the current item's extent.

All results are reflected in the overview map in the upper right-hand corner of the window.

Exclude Item

This option allows the user to exclude an individual search result from the search.

RSS Feeds

This tool allows a user to open search results in an RSS Feed, which will automatically notify them if something in their results changes.

See also: OpenSearch, RSS, Atom

Working with Views

Once your index is created, you can view the items in the index in various ways, allowing you to visualize your information in the most appropriate way. Views are used to display the data in a layout of your choice (Summary View, Grid View, Map View, Table View, or Report View), with a configurable set of fields displayed and providing a useful set of filters for further refining your queries.

Display Options

The View tab enables a user to determine how they want the data to be displayed. There are five view options: Summary, Grid, Map, Table and Report.

Summary View

The summary view displays a few pieces of information about each item, along with the thumbnail for the item.

To configure which fields are displayed, see Configure Display

Grid View

The grid view displays each item as a thumbnail only. When you hover over a thumbnail, more information about that item is displayed.

Map View

The map view displays the relationship between the data and where it lies spatially.

Table View

The table view displays results as a list. This is useful for comparing results based on a property, such as the size of the item in Bytes or the time it took to index the item.

To configure which fields are shown in the table, see Configure Table.

Alternatively use the Export Result List tool.

Report View

Report View generates graphs based on the configurable set of filters used to narrow search results. Graphs include pie and bar charts, are interactive and will work in any web browser (without the need for special plug-ins such as Flash or Silverlight).

To configure the charts and graphs, see Configure Reports

View Configuration

Views are fully configurable, allowing you to change the filters, reports, sort, display, and table options.  Any user with the ''configure_views'' permission can create custom views.

Configure Filters

This option allows you to select fields that will be used to filter query results. The filters are used to show a subset of the data, giving you a better idea of the types of data in the index and helping you refine your search.

To add a filter, simply drag and drop a field name from the field list on the left to the filter list on the right. You can search for fields by name, or narrow down the field list by displaying only fields of certain data types (text, numbers, and/or dates).  The display order the filters can also be changed by dragging and dropping field names within the filter list.  To remove a field from the filter list, click the x to the right of the field name.  For additional filter configuration options, click the arrow next to the field name to edit the filter Style, Minimum, and Sort properties.

The default filters are Type, Subtype, Format, Geometry Type, Keywords, Properties, Author, Spatial Reference, Version, Theme, File Extension, and Location, but these may be deleted or modified as needed.

Filter Style

The Style option determines how filters are applied to your search results.

Select: This is the default filter style.  It shows each of the available options and allows you to click on a single value to refine your search. Note that once a value is selected the filter will be applied and other filterable values will no longer be available.  For example, if you select Polygon, all other geometry types will be removed from your search results.

Checkbox: This filter style uses check boxes to select from multiple values at the same time.  For example, if you check the Polygon box, you can then check Polyline and Point to add other geometry types back into your search.

Filter Minimum

The Minimum setting defines how many matching records must be present in the search results for a filter to be enabled.  For a Select-style filter, by default the filter will only be enabled if at least one record in the search results matches.  That is, the default minimum for Select filters is 1.  For Checkbox-style filters, the default minimum is 0, so Checkbox filters will be displayed by default even if there are no matching records in the search results.

Filter Sort

The Sort options determines whether filters are ordered by the number (highest to lowest) of matching records in the search results or alphabetically by the filter field name.

Show Additional Catalogs

To view data from both local and remote catalogs, select the Show Additional Catalogs option.

Show Dynamic Labels

If dynamic labels are configured, they can be toggled on and off from Configure Filters.  See Dynamic Labeling[ |DOC:Show Dynamic Labels]for more information.

Configure Display

This option allows you to choose the information that will be displayed for each record and how the display will be formatted. The items chosen here will all be displayed in the Detail page for the record, but some will also be visible in Summary View, when hovering over a thumbnail in Grid View, and in Map View.

Fields Tab

To add a display field, drag and drop a field name from the field list on the left to the output field list on the right. You can search for fields by name, or narrow down the field list by displaying only fields of certain data types (text, numbers, and/or dates).  The display order the fields can also be changed by dragging and dropping field names within the output field list.  To remove a field from the filter list, click the x to the right of the field name.  To configure the [style |DOC:Field Style]of the output field, click the arrow next to the field name.

Field Style

The Style option determines how a display field will be formatted.  The options are:

DEFAULT: The field is formatted using the field data type (e.g. date or number).  Field values less than 100 characters long are displayed as links to all records in the catalog that match the field value.       

STRING: The field is displayed as plain text.

HTML: If HTML tags are present, the field is formatted as HTML text.

STRIP_HTML: If HTML tags are present, they are removed and the field is displayed as plain text.

Name Tab

On the Name tab you can specify fields to use as the display name if you don't want to use the file name.  For example, you might want to use an alias name or some other property from the item's metadata.  If the first field is empty, Voyager will try the next field, falling back to the file name if an alternate name is not found in any of the specified fields. 

To add a field to the list of potential name fields, drag and drop a field name from the field list on the left to the column on the right. You can search for fields by name, or narrow down the field list by displaying only fields of certain data types (you may wish to limit the field list to text fields).  The priority of the fields can also be changed by dragging and dropping field names within the list.  To remove a field from the list, click the x to the right of the field name.

Settings Tab

The Settings tab gives you additional options to control what information is displayed for each item.  The options are:

Show Path: The full path including the file name is shown in Summary View and when hovering on a thumbnail in Grid View. 
Show Links: Links to related datasets, databases, and map documents are displayed on the item's Detail page.
Show Sort Field: The value of the field used to sort search results is shown for each item.   
Show all fields on detail page: All information available for an item is displayed on the item's Detail page.
Show Footprints on Map: The item's extent is displayed on the overview map.
Show Format and Spatial Reference: The item's format (shapefile, PDF, ArcMap document, etc.) and spatial reference are shown in Summary View and when hovering on a thumbnail in Grid View.

Configure Table

This option allows you to choose which columns will be displayed in Table View. 

To add a column to the table, drag and drop a field name from the field list on the left to the column list on the right. You can search for fields by name, or narrow down the field list by displaying only fields of certain data types (text, numbers, and/or dates).  The display order the columns can also be changed by dragging and dropping field names within the column list.  To remove a field from the column list, click the x to the right of the field name.  

Configure Reports

The reporting view displays a graph for each of the fields used to filter query results (as seen on the right side of the Voyager interface). To hide or remove a report the appropriate field can be added or removed from the list of filters. 

To add a report, drag and drop a field name from the field list on the left to the report list on the right. You can search for fields by name, or narrow down the field list by displaying only fields of certain data types (text, numbers, and/or dates).  The display order of the reports can also be changed by dragging and dropping field names within the report list.  To remove a field from the report list, click the x to the right of the field name.  For report filter configuration options, click the arrow next to the field name to edit the report Style, Minimum, and [Sort |DOC:Report Sort]properties.

Report Style

Reports can be displayed as either pie charts or bar graphs.  Pie charts display the percentage of records that fall into each category, while bar graphs display the raw number of matching records.

Report Minimum

This is the minimum number of records required for a category to be included in a report.  It can be used to suppress the display of categories that make up only a very small portion of the search results.

Report Sort

The Sort options determines whether categories are ordered by the number (highest to lowest) of matching records in the search results or alphabetically by category.

Configure Sort

This option allows you to choose which fields are available for sorting query results.

To add a field to the sort menu, drag and drop a field name from the source field list on the left to the sort field list on the right. You can search for fields by name, or narrow down the field list by displaying only fields of certain data types (text, numbers, and/or dates).  The display order the sort fields can also be changed by dragging and dropping field names within the list on the right.  To remove a field from the sort menu, click the x to the right of the field name.

Saved Searches

After configuring searches, it is good to save them, so you can use them in the future.

This tool allows a user to save their search results, name the search, give it a description and come back to that data at a later time or use it as the default search.

For a complete list of your Saved Searches, go to the Saved Searches page from the [Home |DOC:Home Menu]menu.

Default Search Configuration

A default search can be configured and saved, so all users will see the same filters, display fields, table layout, and default view.  To create a default search, configure the options to be used as default. Once everything is configured correctly, go to the "Tools" menu and select "Save This Search...".  Enter a Title and Description for the search and select the "Use As Default Search" option.

To set the default search to a Saved Search that was previously configured, go to the Saved Searches page and on the "Options" menu select "Show Edit Options".  Edit any of the existing Saved Searches and select the "Use As Default Search" option.

Processing

This tool allows a user to run the results of a search through a task or process, for example: Clip and Ship, Convert to KML, Create Default Metadata, Mosaic, etc. The user decides whether to run their process on the desktop or a server.

• If the option to Process Results on Server is chosen, the processing happens on the server and the user can download the results when it is finished.
• If the option to Process Results on Desktop is selected, the processing happens on the user's desktop machine and the results are accessible directly.

Server vs Desktop

The same processes can run locally on the desktop or remotely on the server. The desktop option is only enabled if Voyager Desktop is installed on the client machine.  The server option is only enabled if the license level is Workgroup or higher.

If a process is run on the desktop, the output is accessible directly from the local machine via the "open" link under "Output".

If a process is run on the server, the output is added to a zip file that can be downloaded via the "download" link under "Output".

Standard Processes

While Voyager delivers many useful processing tools out of the box, the framework is designed to be extendable to your specific needs. For more information, see the Custom Processes section of the Developer Guide.

Add to File Geodatabase

Add to File Geodatabase adds your search results to a new or existing file geodatabase.  If the file geodatabase name you specify already exists in the output location, Voyager will add your search results to the existing geodatabase.  Otherwise, Voyager will create and populate a new file geodatabase with the name you specify.

Clip and Ship

Clip and Ship gives a user the ability to extract a region of the results into a distributable bundle.  Select the region to clip, browse for an output location and click Execute.

Convert to KML

This gives the user the ability to convert a search result to KML. Select a region to clip, browse an output location and click Execute.

Create GeoPDF

Create GeoPDF gives a user the ability to create a GeoPDF containing a layer for each of the results. Select the region to clip, browse for an output location, choose a name for the new PDF and click Execute.

Create Default Metadata

This process allows a user to create default metadata for data that does not currently have any metadata associated with it.

Create Mosaic Dataset

Create Mosaic Dataset allows a user to create a mosaic dataset from raster datasets in the index. Browse for an output location and click Execute.

Create MXD

Create MXD makes a new MXD displaying your search results, or you can add search results to an existing MXD.  Voyager will automatically create a new MXD if the MXD name you specify does not already exist in the output directory.  If it does exist, the search results will be added to the existing MXD.

Copy Data

This process allows a user to copy data from one location to another.

Mosaic

This process allows a user to combine imagery into a single raster.

Process History

The Process History Page displays two links to previously run [Processes |DOC:Processing]on either the Desktop or Server.




In the process history you can see a list of processes that have been run and the times they finished.  Clicking the Process name shows you the process details, and the Results link opens the output location.

The Query link will re-run the query that was used to select the input records.  This is useful if you want to run multiple processes on a set of search results and they are not already saved to a [list |DOC:Add Results to List]or a[saved search|DOC:Saved Searches].

ArcMap Toolbar

The Voyager ArcMap Toolbar provides seamless integration with ArcGIS Desktop. It allows you to search the Voyager index using text and spatial queries as well as drag-and-drop search results from Voyager Desktop into ArcMap.

The toolbar comes bundled with Voyager Desktop. It is an option that can be installed at the end of the installation process. See the Voyager Tools Installer section for more details.
ArcMap integration works on ArcGIS 9.3, 9.3.1, 10.0, and 10.1.

The toolbar can be found in the list of ArcMap toolbars under "Voyager". Enabling it will allow the user to search the Voyager index by entering a text-based search, like "cities" or "roads", into the Voyager Toolbar textbox, or perform a spatial search by drawing an extent in ArcMap using one of the Voyager Search tools: Search Using Intersection or Search Within.  Results of any query from the Voyager ArcMap Toolbar are displayed in the Voyager window.  You can also launch Voyager manually using the Launch Voyager button.

Drag to ArcMap

Search results found in Voyager can be added directly into ArcMap by simply dragging the item's thumbnail into ArcMap.  The item can be placed at a specific location in the ArcMap Table of Contents by dragging the item over the TOC until the correct location is found, and then dropping it.  The combination of easily finding data using Voyager directly or via the ArcMap Toolbar, then creating your map using the drag-and-drop feature will allow users to create maps faster than ever.

Search From ArcMap

Draw box in ArcMap and get results in Voyager.

Generating Reports

Reports you can generate from your search results include a Usage Report, which tells you how data sources are used within map documents, and a Field Values Report, which lists field names and their distinct values.  Reports are created as .csv files and downloaded automatically in a web browser.  You can then view the resulting file in Microsoft Excel or a text editor.

Usage Report

Usage reports can be created to show how data sources are used within map documents and layer files. 

Field Values Report

Working with Lists

Lists hold search results that can be used at a later time, much like a shopping cart in an online store.

Add Results to List

This tool gives a user the option of either adding their data search results to an existing list or creating a new list. Lists are useful when you are building up a set of data that you want to do something with later on (much like adding things to a shopping cart).  Once a list has been created, all the results in that list can be run through one of the processes, opened in ArcMap, exported to a CSV file, etc.



New List Option - Items can be added to a new list:

Existing List Option - Items can be added to an existing list:

Export Result List

This tool allows the user to export the list of results to different formats, including: CSV, XML, or even to a shapefile.  

The fields that will be exported to the list are configurable. A few default fields have been set: id, name, path, and format. To add a field, simply drag and drop a field name from column on the left to the output field list on the right. You can search for fields by name, or narrow down the field list by displaying only fields of certain data types (text, numbers, and/or dates).  The display order of the output fields can also be changed by dragging and dropping field names within the field list.  To remove a field from the  list, click the x to the right of the field name.

Export Result List to Shapefile

Selecting the SHP option in Export Result List exports a polygon shapefile representing the extents of each search result.  The fields selected for export make up the shapefile attributes.

You can preview the output geometry by zooming to the area of interest in the overview map or in Map View. 

The exported shapefile is shown below in ArcMap.  Note that the "id" field in the attribute table displays the Voyager ID.

Administrator Guide

This Administrator Guide describes how to manage and configure Voyager, including information on discovery, the index, general appearance and mapping settings, extensions and security settings.

Manage Voyager

These features allow the user to adjust and configure the Discovery, Index, Settings, Extensions, Security, and System portions of Voyager as well as check for software updates.  Navigate to these features by clicking Manage in the upper right-hand corner.

!Manage 002.png!

Discovery

The Discovery section allows a user to configure the details of the data discovery and thumbnail generation process, as well as view the Discovery Status, Locations, Schedule, Settings, and Popup Blocker.

Discovery Status

The Status page indicates if the discovery process is enabled, and shows the number of pending tasks in the indexing and thumbnail queues. A user can start or stop indexing via Enable/Disable Discovery. Queue All Locations will add all configured locations to the queue. While indexing, Voyager caches results so the items may not immediately viewable in the index. Sync Search Index pushes all items that are held in the discovery cache into the viewable index. Reset Indexing stops all currently running indexing processes, clears the queue and increments the index ID. 

Thumbnail processing is also managed on this page. Check for Thumbnails to Build will attempt to process any items without thumbnails.  Manage Thumbnail Queue allows you to abort any pending thumbnails or restart aborted thumbnail processes.

Discovery Queue

The discovery queue is a list containing all of the items to search and extract information from.  The queue initially starts off with the folder or URL pointing to the location being indexed, but will grow as new items are found within that location.  Voyager will continue crawling through the location and adding items to the queue until it has found and indexed all supported items within that location.

Locations

The Locations page is used to specify where Voyager should scan for datasets, map documents and other resources.  Depending on your license level, locations can either be local, on a network, or web-based.

Location information is displayed and contains the name, path, count of items discovered at this location, as well as an option to queue the location and manage the discovery settings for this specific location.

Directory

A directory or folder can be added as a location in Voyager.  For example you could add "D:\data" or "
server\share" as valid locations. To add a location, click the "Browse" button on the Directory tab under Add Location and navigate to the target folder.  Click "Add Location."  The folder now appears in the Locations list and can be added to the discovery queue or managed.

If you are new to Voyager it is best to start with a discovery location that contains only a few datasets. As your experience grows you can add larger amounts of data.

To add an ArcSDE connection, browse to the folder that contains the SDE connection file (e.g. MyConnection.sde).  

Web Services

In addition to indexing items on disk, Voyager also indexes web services.  To add a web service to the list of discovery locations, click the "Web Service" tab on the "Locations" page.  Enter the URL to a web service and choose whether it is WMS (Web Map Service), AGS (ArcGIS Service), or CSW (Web Catalog Service).  Choosing to "Validate" will immediately verify whether the server exists at the specified URL and will report whether Voyager can successfully extract information from the web service.

AGS Indexing

ArcGIS Server web services can be added to the index from the Locations page.  Enter the URL to the services directory on the ArcGIS Server, select "AGS" from the dropdown and choose whether to immediately validate the URL.  This will index all supported services on this ArcGIS Server.

It is also possible to enter a URL to a specific directory or service on the server.  The image below shows three valid ArcGIS Server URLs.  The first is to an ArcGIS Server (ArcGIS Online), the second is to a folder within the server (ArcGIS Online - Elevation Directory), and the third is to a specific map service (World_Street_Map).

CSW Indexing

Web Catalog Services can be added to the index from the Locations page.  Enter the URL to the CSW, select "CSW" from the dropdown and choose whether to immediately validate the URL.

WMS Indexing

Web Map Services can be added to the index from the Locations page.  Enter the URL to the WMS, select "WMS" from the dropdown and choose whether to immediately validate the URL.

FME Indexing

FME web services can be added to the index from the Locations page.  Enter the URL to the FME web service, select "FME" from the dropdown and choose whether to immediately validate the URL.

Manage Location

The discovery settings for each location can be configured using the location's "manage" link. A dialog is displayed showing the various options to configure including: Location name, Watch File System For Changes, Schedule, Filters, Look For Changes Since, Settings, as well as the option to Queue the location or Remove the location from the list. The settings configured here will apply only to this location, not to the overall index.

Change Location Display Name

The display name of the location can be changed by clicking on the name at the top of the dialog. For example, clicking as shown below brings up an editable field where the name can be modified.

Schedule Location

The discovery process for a specific Location can be scheduled to run automatically. Choose from an existing schedule task and add it to the location.  See Schedule for more information on configuring schedule tasks.

Watch File System for changes

You can choose to watch a location for any changes made to the directory on the file system. The Voyager index will be updated immediately if a file in the 'watched' location changes.

Location Filters

Configuring filters allows you to choose which types of data you want Voyager to search for. Filters are used to include or exclude files or folders that are found within this location.  You can create filters based on just the file name or on the full file path. 

For example, you could choose to add only MXDs within this location to the index. To do this, choose "Edit" under "Filter Name" and enter "+suffix .mxd" as shown below.  Then click "Save" and the filter will be saved for this location.  For more examples, see Filter Syntax.

Filter Syntax

Each non-comment, non-blank line contains an expression prefixed by '+' or '-'. The first matching pattern in the file determines whether a path is included or ignored. If no pattern matches, the path is ignored.

The expression types are:

suffix

-suffix .xml

Will skip anything that ends with ".xml"

prefix

-prefix test

Will skip anything that starts with "test"

regex

-regex .*(\.prj|\.aux|\.sdi|\.shx|\.dbf)

Will skip these suffixes

-regex .*(/.+?)/.*?\1/.*?\1/

sikp paths with slash-delimited segment that repeats 3+ times, to break loops

glob

-glob *_TEST_*

remove things that contain TEST

all

+all

match everything

Example Filter Rules

# Ignore standard helper files
-regex .*(\.prj|\.aux|\.sdi|\.shx|\.dbf)

# Ignore XML
-suffix .xml

# accept everything with an extension (2,3,4 chars long)
+regex .*\..{2,4}

matches all extensions that are 2, 3, or 4 characters long but not xml,prj,aux,sdi,shx,dbf

Location Security

When Location Based Access is enabled, additional Security settings are available on the Manage Locations screen.  For each location, you can specify which groups have access to the location.  Users assigned to groups that do not have access will not see search results from these locations.

Location Discovery Settings

Each location can override the default Data Discovery Settings

Queue or Remove a Location

The location can added to the discovery queue by clicking "Queue Location". It can be completely removed from the list of locations by clicking "Remove Location".

Exclude List

During the discovery process, you may want to exclude certain system folders, file types, files with certain prefixes, etc. from the index - regardless of which discovery location the item may be found in. The "Exclude List" is a global list of things Voyager will skip when indexing.

For example, you may want to ensure that items within the "C:\Windows" folder are never indexed by Voyager. To do this, click "Exclude List", then "Add". A dialog is displayed allowing you to configure what to exclude.

To exclude the "C:\Windows" folder, select "Folder" from the dropdown menu and choose "C:\WINDOWS" from the list.  Click "Exclude", and the folder you selected will be added to the Exclude List.

To remove the location from the Exclude List, click the '\[x\]' and the folder will no longer be excluded from the discovery process.

In addition to excluding system folders, you can exclude items based on wildcards, or regular expressions (regex). For example, if you want to exclude everything with the prefix "test_" from the index, select the Wildcard option and enter "test_*" as the Pattern.

Schedule

The Schedule feature allows the user to specify when Voyager will discover data.

The schedule of data discovery is displayed, along with options to explicitly run the task or manage specific tasks.

Triggers can be added, setting up the discovery process to run based on time of day, periodically, chronologically or on specific events.

Discovery Settings

The Settings page allows a user to manage the common discovery settings, which will affect discovery for all locations that have not had their location-specific settings configured.  Configuration options include: Data Discovery,Thumbnail Creation, DOC123:Indexing Timeouts, and Metadata Extraction.  The user can also view and configure the list of supported formats.

Data Discovery Settings

Thread Count

Specifies the number of concurrent threads that will be running during data discovery

Default Settings

The following settings are applied across all discovery locations.  For examples where overriding the default discovery settings can improve indexing performance, see Recommended Configurations.

Ignore Imagery Without Spatial Reference

Excludes data without spatial reference from the index

Calculate MD5 Checksum

Detecting duplicate data within your index can be performed using MD5 checksum, which is a very accurate method of detection. However, the calculation is slower than the default methods of detecting duplicates (using a content hash and schema hash) , so this option should only be enabled if a high degree of accuracy is needed in duplicate detection.

Build Thumbnails in Separate Process

Thumbnails can be built within the same process as the data discovery, or within a separate process. Building thumbnails in a separate process means all results will be displayed quickly, but their thumbnails may take a bit more time to be generated. Building thumbnails within the same process as the data discovery reduces the overall indexing time for a large number of files, but certain types of results such as MXDs and layer files will be slower to index.

Generate Raster Thumbnails On-The-Fly

Because generating raster thumbnails with GDAL is fast, you can choose to create thumbnails when a user views the data instead of doing it during the indexing process. This saves time during indexing and is most beneficial if you have large amounts of raster data to index.

Save Layer File for Rasters

By default Voyager does not create .lyr files for raster files that are indexed. If Voyager Desktop will not be installed, but you want the option to download .lyr files for items, you can choose to always save layers files for rasters.

Cache All Metadata Records

When metadata is stored as simple .xml files on disk, Voyager will show this file directly when someone askes to see the metadata in the UI. This works well when the index and data will stay together. If you intend to index data, and show the contents disconnected from the data, you may want to cache a copy of the metadata xml in voyager's internal cache.

Ignore Metadata

When indexing large repositories that do not have metadata or where you do not care about the metadata values, ignoring metadata can speed up the indexing process. This will avoid an extra File lookup for each file.

Skip Discovery Queue

While indexing, Voyager normally puts every file and folder into the discovery queue. This provides fault tolerance, gives good statistics, and allows for better indexing load balancing. When indexing large collections of very small data, the overhead to queue items can outweigh the the actual indexing time. In these cases, you may consider skipping the discovery queue.

Thumbnail Creation Settings

Thread Count

Specifies the number of concurrent threads that will be running to create thumbnails

Layer File Settings

Layer File Version

For backwards compatibility, you may want to save .lyr files in an earlier ArcGIS version.

Indexing Timeouts

A user can configure how long Voyager should try to index a given item. The default timeout for all types is 5 minutes. An example of an "item" could be an individual Layer File, a single GIF, a single feature class within an SDE database, an MXD file, etc.

Clicking Add Timeout brings up a screen allowing the user to create additional timeouts. The timeout can be based on a file format or a wildcard.

Supported Formats

To manage the supported formats within Voyager, see: http://localhost:8888/manage/discovery/formats

Simple File Indexer

The Simple File Indexer enables indexing of basic file properties such as file name, path, size, modified/created date, etc. for file types that are not included in Supported Formats.  See Filter Syntax for examples of how to include or exclude specific file types.

Custom Metadata Extraction

Metadata extraction allows for fine grained control of values extracted from metadata records. This allows Voyager to support any metadata profile including custom user-defined fields.  

To configure simply add fields using the appropriate XPath syntax and appropriate information. 

To test query logic use the following form

The configuration is saved in:
data.dir/config/meta.csv

Once established, fields will be available through View Configuration

Popup Blocker

The popup blocker closes windows that may open during the data discovery process. For example a dialog box is sometimes displayed when indexing ESRI Map documents. While this is helpful for users running ArcGIS on the desktop it’s not good in a server environment. Considering that there aren’t any configuration settings to block these windows we’ve added a popup blocker to eliminate them. It’s possible to turn the blocker on or off and to also view the log file for information on windows that were dismissed.

Index

The Index management page gives the Voyager administrator access to the Query Settings configuration page, which is used to set the appropriate query fields, display order and bounding box for the current Voyager index.  The Index page also allows an admin to Clear the Search Index, which removes all entries from the search results.

Query Settings

Query Settings are global preferences that are applied to all queries without input from the end user. These settings can change without the need to reindex.
NOTE: These options are only available for WORKGROUP/ENTERPRISE

Query Fields

List of fields and the "boosts" to associate with each of them when building DisjunctionMaxQueries from the user's query. The format supported is:

fieldOne^2.3 fieldTwo fieldThree^0.4

This indicates that fieldOne has a boost of 2.3, fieldTwo has the default boost, and fieldThree has a boost of 0.4. With this setting, matches in fieldOne are much more significant than matches in fieldTwo, which are more significant than matches in fieldThree.

For more information, see: http://wiki.apache.org/solr/DisMaxQParserPlugin

Append Parameters

This option adds additional parameters to the Voyager search, giving you finer control over how search results are sorted by using indexed values in addition to text search values when determining relevance.

For example, you can give higher prior to raster data:

or to items with thumbnails:

In these examples, 3 is the boost value.  

It is also possible to prioritize results from particular discovery locations.  To do this, select the desired location under Refine Your Search.  The location ID is displayed in the browser address bar.  If you are using Voyager Desktop, click the link in the bottom left to open the Voyager site manager.  Copy the location ID from the URL.

Now go to Manage > Index > Query Settings.  Under Append Parameters, enter an expression like the one below:

To elevate search results based on multiple indexed values, you can enter multiple queries on separate lines:

Calculate Bounding Box

Select if the bounding box should be calculated for all results. When calculated, this will display a blue box on the overview map representing the extent of all matching results.

When working with very large indexes (5M\+ docs), it may be preferable to skip this calculation since it can be time consuming.

Force Sort

Force Sort gives you the option of overriding relevance scores and always returning search results based on a specified query.

In the example below, records from the two configured locations will always be displayed before records from other locations.  This means that weaker matches from these locations will be prioritized over more relevant records from other locations.

Query Synonyms

Synonyms can be managed from within the synonym configuration page. Options exist for adding new synonym lists or modifying existing ones. It is also possible to test keyword searches to determine which synonyms will be returned. 

Synonym Configuration Page

Option for adding new synonym lists

Voyager provides a set of standard synonym lists that can be added to the application, or a custom list of synonyms can be created.

Synonym Editor

All synonyms for a word or phrase should be entered on a single line within the text box. Each line contains all synonyms for that word or phrase, separated by a comma.

Test Keywords for a Synonym Match

To test which values Voyager will search for, use the Test Query box. All synonyms Voyager finds for the text that was entered will be displayed below, and can be queried immediately.

Dynamic Labeling

Dynamic Labeling enables you to build filters on the fly by tagging records at runtime based on a query.

For example, suppose you want to create a filter based on a spatial query.  Start by drawing the desired extent on the overview map or in Map View.  

Next, copy the URL from the browser address bar.  If you are using Voyager Desktop, click the link at the bottom left to open the Voyager site manager and copy the URL from there.

Now go to Manage > Index > Dynamic Labeling.  Paste the URL into the Query field.  Enter a name for the query in the Label field - this is the label that will be displayed in the filter list.  Click "Add".

To activate the filter, check the "Enabled" box.  Click "Show Dynamic Labels" to return to the Voyager Search page and see the new filter right below the overview map.

Federated Catalog Search

Federated Catalog Search allows you to add links to multiple Voyager catalogs (indexes) and view them within a single Voyager application.

To add a new catalog, enter the URL to the Voyager instance in the "Add Catalog" box and click "Add".  Also edit or remove existing catalogs via the "Edit" and "Remove" options.

Backup and Restore

The Backup Index tool writes a copy of the index to disk that can be reloaded later.

The Restore Index tool can be used to restore a backup index

Rebuild Index is useful for regenerating the index after a major format or configuration change has happened. This is essentially the same as using Backup and Restore with the exception that it skips the steps of reading and writing the index to to disk.

Clear Index

This feature allows the user to clear out all items in the index of discovered data.

Settings

From the Settings page, a user can enter their site-specific Voyager URL, load or save Profiles, control the Appearance of Voyager, configure Mapping options, manage ArcGIS license settings, configure Logging processes, and enter License information.

Voyager URL

When Voyager is deployed as a server, the Voyager URL must be set so web-based users can navigate to Voyager. A valid host machine or web URL must be entered. For more information see Changing Voyager Desktop URL.

When using Voyager on a network, it is important to configure the URL it should be pointing to.

Specifically, this is required to support:

• RSS Feeds
• Connecting Voyager Desktop
• CSW Server

Profiles

A user can export their current profile, or load in an existing profile.  A profile includes: General Settings, Discovery Settings, Saved Searches, Appearance, and Map Settings.  Default factory settings can be restored from the Load Settings option.

Appearance

This feature allows a user to control the look and feel of Voyager including Localization, site footer and site color.

Localization

This setting allows you to choose the language that Voyager will use.

Disable External Links

External links can be disabled within Voyager.

Hide Powered By Logo: This prevents the Voyager logo at the bottom of each page from being displayed.
Disable Powered By Logo: The Voyager logo is displayed, but the link to the Voyager website is disabled.
Disable External Help Links: The Help menu within Voyager is disabled.

Site Footer

This is inserted right before the body element.

One common use for this is to add usage tracking to Voyager. For example, this will add google analytics:

<script type="text/javascript">
var gaJsHost = (("https:" == document.location.protocol) ? "https://ssl." : "http://www.");
document.write(unescape("%3Cscript src='" + gaJsHost + "google-analytics.com/ga.js' type='text/javascript'%3E%3C/script%3E"));
</script>
<script type="text/javascript">
var pageTracker = _gat._getTracker("Your Key Here");
pageTracker._initData();
pageTracker._trackPageview();
</script>

Site Color

Change the site color to match your Custom Logo

Custom Logo

With an enterprise license, you can change the logo to represent your own organization.

To add your logo to Voyager, create a logo file called "header.png" and copy it to the following location:

ArcGIS

The ArcGIS page displays whether Voyager has access to an ArcGIS license for use in indexing MXDs, layer files, geodatabases, and other Esri formats.  If licenses of different levels are available on the license server, you can check "Use Lower Products First" to determine the license checkout order.  Voyager will first try to check out an ArcView/Basic license, then ArcEditor/Standard, and finally ArcInfo/Advanced.  The license is only required while indexing Esri data or performing Esri-based processing tasks such as Clip and Ship and Mosaic.

Mapping

This feature allows a user to configure map connections. You can choose a default base map, decide to enable or disable Google Maps, or add map services including WMS, ArcGIS, caching, and OpenLayers base maps. Default map settings can be restored from the Map Settings option.

Caching Base Map

Base map tiles are normally drawn on demand as an extent is viewed.  Caching the base map downloads map tiles in advance so that the map can be accessed in the field or on a closed network, or simply to improve performance.

The map cache is stored in <VoyagerInstallDir>\data\maps.  You can move the maps directory to a different location if necessary.  For example, you might need to install Voyager on a new server or move the map cache to a drive with more storage space.

After moving the map cache, edit Voyager.vmoptions to point to the new location of the maps directory.  If the -Dmap.cache.dir setting is not present, add it as shown below.

For a new Voyager installation, you will also need to copy <VoyagerInstallDir>\data\config\maps.dex from the existing Voyager server to the new Voyager server.  Maps.dex contains the configuration settings from the Mapping page in Voyager.

If maps.dex is missing or corrupted, simply re-run the steps to cache the base map.  Voyager will recognize the existing map cache instead of downloading the map tiles over again. 

Logging

This feature allows a user to configure logging for their Voyager instance.

Access Logging \- NCSA request logging can be enabled. 

Configure Log4J \- The logging level can be set based on 6 possible logging levels, ranging from very detailed (TRACE) to very general (FATAL). The default logging level is INFO. The Voyager default log4j file can be used to configure logging or the user can create a custom configuration.

License

This page displays the current license and enables you to enter or update license information.  Clicking the License link displays additional license details on the Voyager website.  For more information, see Managing Licenses.

Extensions

The Extensions page gives access to manage any installed extensions.

Enterprise licenses include the CSW Extension

CSW Server

The CSW Extension exposes the Voyager index as an OGC Compliant CSW Service.

To enable this extension. Check the 'enabled' button and hit save. In addition, set the relevant service information to publish with the service.

When the service is enabled, you can access the csw service from: http://localhost:8888/csw

Sample XML output looks like:

Security

Security

Voyager can integrate with existing security and access control systems including LDAP and Active Directory based authentication as well as a Voyager based internal authentication model.

From the Security page, the administrator can configure the authentication model, user accounts, permissions, and role-based access as well as view user sessions.

Security Authentication

The authentication page allows you to choose the authentication model that you wish to use. You can choose from Voyager's Internal, Windows or LDAP authentication.
Remember-me authentication allows Voyager to remember the identity of a person between sessions.

Password properties can be set including: the minimum password length, password expiration and complexity, and cookie settings.  An administrator can also set the number of times a user can attempt to access Voyager with an incorrect password before being locked out for a specified period of time.

Internal Authentication

Voyager's default authentication model uses configurable users and groups to control how people access and use Voyager. 

Windows Authentication

Voyager's configuration for Windows Authentication enables you to integrate Voyager into a Windows domain environment, providing a better search experience for your users.  Single Sign-On uses domain credentials to log in to Voyager automatically.

To set up Single Sign-On, first run the following command to register the Service Principal Name (SPN) for the Voyager server:

setspn -A HTTP/machine:port username

where machine:port is the machine and port the Voyager service is running on and username is the Voyager service account. 

On the Single Sign-On tab, check Enable Negotiate.  Click the SPN tab to test the configuration.  You should see the Voyager server name under Registered ServicePrincipalNames.  

If the Voyager server name does not appear under RegisteredServicePrincipalNames or the SPN tab shows an error:

1. Verify that Voyager is running as a service, and that the service account is on the same domain on the machine.
2. Re-run setspn \-A HTTP/machine:port username.
3. Check the SPN tab again.  If the Voyager server name is still not present, check Enable NTLM.

LDAP Authentication

Voyager's LDAP connector enables you to integrate Voyager into existing security environments by mapping Voyager's role based security to LDAP groups and user accounts.  

Users

The Users page is used to manage Voyager users.

The list of currently configured users is displayed:


Clicking on the user's name brings up the Manage Account page for that user.  The user can be deleted, the user's password properties and roles can be modified, and the user's password can be changed.

New Account allows the administrator to enter a new user's name, password, and group:

Enter properties for the new account

Sessions

The Sessions page displays a list of people that are currently connected to the Voyager Server. Information relating to user name, host IP address, the page that they are currently accessing as well as the time that the session was created and when it was last accessed is displayed.

Permissions

The Permissions page displays a table of Voyager capabilities and user roles. Modifying this table changes which parts of Voyager a certain role has access to. There are different levels of the user interface that can be enabled or disabled, tasks that can be allowed or disallowed, and management capabilities that can be turned on or off for each role.

For example, you could configure Anonymous users to only have the ability to Use Voyager and Show Metadata, but nothing else. Clicking on a green checkmark (turning it into a grey x) will disable that particular functionality, and vice versa.

LDAP Roles

If your license features authentication with Active Directory or LDAP, a drop down will appear below the permissions table. You can add a role from your directory and configure what permissions it should have.

Access

Role based security settings, configured by a Voyager administrator, allow you to control the types of data that a person can access. Examples might include allowing users to only view items based on indexing location (restrict access to data on a specific server) or based on a query setting (such as restrict access to items with metadata). See Location Based and Query Based Access for more information

Location Based Access

Location based access leverages Data Discovery Locations as a way to configure which a users can or cannot see. Once the option is enabled Administrators can click on the Locations link to open the data discovery Locations page. From there they can edit access setting for each location.

{_}Show Orphan Data{_} configures Voyager to display data that might not have an indexing location associated to it. This can happen when a location was removed from the indexing settings but the administrator choose an optional setting to keep the locations items in the index.

Configure security settings using the Manage Location options.

Query Based Access

To choose which type of access each user role has the administrator would click the Edit link and specify filters, or a Voyager URL to extract filters. 

Create a voyager query that would limit data based on your needs. For example, the following query constrains search results to only items containing metadata:

http://localhost:888/voyager/#/f.properties=hasMetadata/

Entering the query will strip off extraneous information
Once Access is set, the administrator will see statistics showing the number of records that will be affect. The Access filtering can be edited or completely removed at any time to grant full permissions to all files for the specified user type. 

Access Logging

For more information on Access logging, see Logging

By default all security related requests are written to their own log file in ${data.dir}/logs/voyager-security.log

This will include information:

• when a user logs in
• when a user logs out
• when a failed login attempt
• account is locked

The default logging settings simply write information to log files. The relevant log settings are:

Through log4j settings, this could be changed to write to a database or send email.

Session Expired

A management session will timeout after being inactive for 30 minutes in order to release the session for other users and for browser performance.  Before the timeout occurs, Voyager will notify you that your session will expire soon. 

To keep the the current session alive, click "Continue".  Doing nothing will allow the session to expire.  Clicking "Manage Voyager" will return you to an active session.

Admin Options

Users with permission to manage Voyager will see the Admin Options menu on the search results page and on the Detail page for each item.  The options are Remove results from the Index, Add results to discovery queue, and Show Raw Query.  

Remove Results from the Index

Selecting "Remove results from the index" removes search results from the Voyager catalog so that they will not appear in future searches.  The source data itself is not affected.  You have the option of also removing associated thumbnails, metadata, and layers.

To remove an individual item from the catalog, go to the item's detail page and select "Remove results from the index" from there.

Add Results to Discovery Queue

The "Add results to discovery queue" option is useful if you want to update selected Voyager records without re-indexing the entire location where the source data resides.

To re-index an individual item, go to the item's detail page and select "Add results to discovery queue" from there.

Show Raw Query

"Show Raw Query" shows the query that generated the current results page in XML or JSON format.  All available metadata fields are displayed for each record, in addition to the search parameters.  The "debug" option also shows how the relevance score was calculated for each record. 

Running as Windows Service

Installing Voyager as a Windows Service

With a WORKGROUP or ENTERPRISE license, you can install Voyager as a windows service.

To configure Voyager to run as a windows service simply execute the following command with the appropriate command-line option:

VoyagerService.exe \[OPTION\]

Options:

The VoyagerService executable is located in the software installation directory at: .\app\VoyagerService.exe

Notes on /install parameter:

As a second parameter after the /install parameter, you can optionally pass a service name. In that way you can:

• Install a service with a different service name than the default name.
• Use the same service executable to start multiple services with different names. To distinguish several running service instances at runtime, you can query the system property exe4j.launchName for the service name. Note that you also have to pass the same service name as the second parameter if you use the /uninstall, /start and /stop parameters.

In some situations, you might want to install a Windows service as a non-interactive service meaning that the service will not have any possibility to access the GUI subsystem. In order to do that, add non-interactive after the /install parameter. A custom service name can still be specified after the non-interactive parameter.

Installing windows services requires administrative permissions

When installing the Voyager service it is important that you are either logged into the computer with an administrative account, or with Windows Vista and Windows 7 you can elevate your permission to run specific processes as an administrator.

Therefore, if you see this type of error it is possible that you do not have the necessary permissions to install the Voyager service:

To resolve the problem be sure to log in with an administrative account or elevate the permissions of your existing account. Elevating the permissions of a process can be done using the context menu on the process executable or via the shortcut illustrated here:

Important note on windows service Logon Account

It is important that the voyager service runs as an account with suitable permission to access data that it should index. Voyager has been designed to require read-only access to data.

A service, like any process, has a security identity that determines the granted rights and privileges for accessing local and network resources. This security identity, or security context, is important in determining how Voyager accesses local and network resources.

When services are installed the default account used for running the service is the windows SYSTEM account. In general this account will not have the necessary permissions to access data to be indexed.

You can view the account that Voyager service uses via the Services dialog:





To change the permissions simply double click on the service name, choose the “log on” tab and the enter the necessary account information:

Administrative Installation Guide

This is an administrative step by step guide to the typical Workgroup or Enterprise Server environment installation.

How to set up Voyager for your web portal URL, different configuration options such ports and directory locations, and running Voyager as a service.

1. Make sure you have the latest version of Voyager installed

Visit voyagergis.com/downloads to check for the most recent release. Note the the availability of both x32 and x64 bit versions. 

2. Administrator Login

Before changes can be made to the Voyager configure from the Desktop Application you will need to login as the administrator user.

Default Administrator Username: admin
Default Administrator Password: admin

3. Verify Licensing

To run Voyager as a service you must have either a Workgroup or Enterprise license.

To verify your license navigate to the License page in the Manage section. If you require a different license than you have or your evaluation / interim license is about to expire please contact sales@voyagergis.com for an updated license file.

3. Set the Voyager URL

To use your company website as your Voyager portal location, the Voyager URL setting must be changed under the Manage>>Settings Page

It is important to note that by default Voyager runs on port 8888. If a different port has been specified to be used, be sure to include this.

Example:

htttp://yourwebsite.com:8888

4. Configure Voyager to Run as a Windows Service

To use Voyager on your server where multiple users may access information, it is good option to run Voyager as a service.  The VoyagerService executable is located in the software installation directory at: <VoyagerInstallDir>\app\VoyagerService.exe.

To configure Voyager to run as a windows service, execute the following command with the appropriate command-line option:

VoyagerService.exe \[OPTION\]

Options:

5. Optionally configure Voyager settings

To optionally configure Voyager ports, folders locations, and other settings, changes are made in the Voyager.vmoptions file, which can be found in: <VoyagerInstallDir>\app.

Some of the most commonly changed settings are what ports Voyager will run on, the folder location of the index and thumbnails generated, URL settings, and any map caching folder that may have been setup.

The following settings can be modified or added to the file:

To run Voyager on non-standard URLs or run within IIS, the following settings can be configured:

6. Share Voyager with others

Share voyager's URL with others. On a default installation this will be http://<machine name>:8888/

7. Configure Indexing Locations

Configure Voyager to index locations. When starting out it is best to start small ensuring that everything is working well and to get a sense for performance. Once you gain experience then it's good to add more locations with more data. 

8. Tune Data Discovery Settings

Tuning data discovery settings can help improve indexing performance.

Unless you are working with a very large amount of imagery (in excess of several hundred thousand items) it is recommended to turn this OFF.

The default settings are a good place to start with the exception of "Generate Raster Thumbnails on the Fly". Having this option checked will delay the creation of thumbnails until they are needed to be displayed in the user interface for the display of search results. This can a small amount of time while indexing but can negatively impact the user experience given that some search results will be displayed to the user as progress indicators while thumbs are generated on the fly.  

9. Tune Data Discovery Performance

Start small with data discovery and thumbnail thread counts increasing the numbers to a point where the computer reaches the maximum of 70-80% CPU utilization. To increase beyond this can lock up your computer.  

10. Configure your basemap

If necessary you can configure Voyager's base map to use any map service that you like.

Run Voyager via IIS

ISAPI Redirect

Install and configure isapi_redirect.dll

• Unzip isapi.zip and copy the extracted isapi directory into: $voyager_install_dir/app

  Example path: C:\voyager\voyager\app\isapi

• Update the $voyager_install_dir/app/isapi/isapi_redirect.properties file:
  • _log_file_: update path to voyager install directory

   Example path: C:\voyager\voyager\app\isapi\isapi_redirect.log

• • _worker_file_: update path to voyager install directory

   Example path: C:\voyager\voyager\app\isapi\conf\workers.properties

• • _worker_mount_update_: update path to voyager install directory

   Example path: C:\voyager\voyager\app\isapi\conf\uriworkermap.properties

• • Save file

  Example isapi_redirect.properties file:

Set Voyager Options

Update the Voyager.vmoptions file (found in $voyager_install_dir/app):

• Modify the following option:
  • \-Dport=-1
• Add the following options:
  • \-Dcontext.path=voyager
  • \-Dexplore.path=explore
  • \-Dport.ajp=8009
• Save file

Example Voyager.vmoptions file:

(For more information on editing the Voyager.vmoptions file see: http://voyagergis.com/doc/current/Voyager.vmoptions)

Launch Voyager

• Start the Voyager service
  1. From a command line, navigate to $voyager_install/app
  2. Run VoyagerService.exe /install
  3. Run VoyagerService.exe /start

(For more information on installing and running Voyager as a Windows Service see: http://voyagergis.com/doc/current/Running%20as%20Windows%20Service)

IIS Configuration

Configure IIS to run Voyager

IIS 5.x and 6.x

• Add a new virtual directory to your IIS web site
  1. From the IIS management console, right-click the website, go to New, Virtual Directory
  2. The name of the virtual directory should be 'voyager'

1. 1. The physical path should be the directory where you placed isapi_redirect.dll ($voyager_install\app\isapi)

1. 1. While creating this new virtual directory assign it with execute access

1. 1. Click Next and Finish

• Add isapi_redirect.dll as a filter in your IIS web site
  1. From the IIS management console, right-click the website, go to Properties, ISAPI Filters
  2. Click Add
  3. The name of the filter should reflect its task (voyager)
  4. The executable must be our $voyager_install\app\isapi\isapi_redirect.dll

1. 1. Click OK and OK

• Restart IIS (stop + start the IIS service)
• Verify that the voyager filter is valid
  1. From the IIS management console, go to the website, right-click and choose Properties
  2. Select ISAPI Filters tab
  3. Verify the filter is marked with a green up-pointing arrow

IIS 7.x

• Add a new ISAPI restriction to your server
  1. From the IIS Manager, select the main server node and find the ISAPI and CGI Restrictions feature
  2. Open it and add a new restriction
  3. The path should be the path to the isapi_redirect.dll ($voyager_install\app\isapi\isapi_redirect.dll)
  4. Set the description to 'voyager'
  5. Enable 'Allow extension path to execute'

• Add a new virtual directory to your IIS web site
  1. From the IIS Manager, right-click the website's node, click Add Virtual Directory...
  2. The name of the virtual directory should be 'voyager'
  3. The physical path should be the directory where you placed isapi_redirect.dll ($voyager_install\app\isapi)

• Add isapi_redirect.dll as a filter in your IIS web site
  1. From the IIS Manager, double-click the ISAPI Filters feature under the website's node
  2. From the Actions pane on the right, click Add..
  3. The name of the filter should reflect its task (voyager)
  4. The executable is $voyager_install\app\isapi\isapi_redirect.dll

• Make sure the ISAPI handler is enabled
  1. From the IIS Manager, select the Handler Mappings feature under the website's node
  2. If ISAPI-dll is in the disabled group, right-click it and select Edit Feature Permissions
  3. Verify that Read, Script and Execute are all selected

!IIS_Handler Mappings2.png!

• Make sure the Application Pool where your application is running is enabled for 32-bit applications
  1. From the IIS Manager, click the Application Pools node
  2. In the Actions pane on the right, select Set Application Pool Defaults...
  3. Set Enable 32-Bit Applications to True

• Restart IIS (stop + start the IIS service)

Test Configuration

• Open your browser and test the default Voyager URL: http://<servername>/voyager

Example: http://localhost/voyager

Voyager.vmoptions

VMOPTIONS File

Additional configuration options are available through the Voyager.vmoptions file, which can be found in <VoyagerInstallDir>\app.  Any changes to Voyager.vmoptions will be applied the next time Voyager is launched, or after restarting the Voyager service.

By default the file contains these settings:

The following settings can be modified or added to the file:

To run Voyager on non-standard URLs or run within IIS, the following settings can be configured:

These settings should only be changed by experienced users. Typically this file will not need to be modified manually. 

Changing Voyager Desktop URL

To use your company website as your Voyager portal location, the Voyager URL setting must be changed under the Manage>>Settings Page

Once the URL has been changed, you must restart Voyager Desktop for the changes to take effect.

It is important to note that by default Voyager runs on port 8888. If a different port has been specified to be used, be sure to include this.

Example:

htttp://yourwebsite.com:8888

For switching between Voyager Servers simply changing the URL will allow the user to see other instances of Voyager that are running in different locations.

Manage Licenses

To request a free license or manage your existing licenses, log into the VoyagerGIS.com management page: http://voyagergis.com/licenses

Request Free License

To request a Free, permanent use license, enter your machine key in the text box provided, click "Request License" and Voyager will generate a new license for you. Simply copy the license using the "Copy to Clipboard" link (or CTRL-C), then paste the license into the setup wizard or license page in the Voyager application (CTRL-V).

Your Pending Licenses

Licenses issued without a machine key will be listed under the pending licenses section. To activate a license enter the machine key by clicking the license product name and enter the machine key in the space provided.

Your Licenses

All of your existing licenses will be listed in this section. To see details of a specific license, click the license product name and view the license details.

Find Your Machine Key

To find your machine key, navigate to the Manage page and click "License". The machine key is listed, as well as the user associated with the license, the type of product it supports, the version and the expiration date.

Command Line Options

User Accounts

Resetting a Password

If you forget your admin password, you can reset it using command line options. However, Voyager provides a graphical interface to make user account management a simpler process for accounts other than admin.

--setUserPassword=[username]:[password]


For example:


c:\voyager\app\>Voyager.exe --setUserPassword=admin:newPassword

Creating an Account

A user account can be created upon startup using the following option:

--createUser=[username]:[password]

For example:

c:\voyager\app\>Voyager.exe --createUser=eddard:stark

Index Management

To run the lucene CheckIndex tool, use the command line:

Voyager.exe --checkIndex

This will list the valid indexes to check. Pick one and run:

Voyager.exe --checkIndex index:v0

Server Configuration

crossdomain.xml

By default Voyager in includes a crossdomain.xml.

If you need a custom crossdomain.xml file, simply place it in:

${data.dir}/config/crossdomain.xml

Voyager Desktop

Voyager Desktop is included within the standard Voyager install. It can be installed independently and point to a central Voyager index.

ArcMap Integration requires Voyager Desktop to be installed

See also: Voyager Desktop vs. Browser

Download

Download Voyager Desktop from: http://voyagergis.com/downloads

Choose the 'with jre' option unless you already have Java 1.6+ installed.

Configure

Common Profile

If you want to configure Voyager Desktop preload standard settings, edit the .dex file next to VoyagerDesktop.exe. By default, this will be installed in:

 C:\voyager\desktop_1.4\app\common\VoyagerDesktop.dex

Add the settings you want applied by default to all users on the machine:

<?xml version="1.0" encoding="utf-8"?>
<settings xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema">
  <url>http://demo.voyagergis.com/services/</url>
  <data>${AppData}\VoyagerDesktop</data>
</settings>

The data path allows for environment location substitution:

Developer Guide

Voyager provides easy to use APIs that will allow you to build custom applications.

Add a Voyager search box to a web page

Adding a search box to a web page is easy with the following code. 

<html lang="en">
  <head>
    <meta charset="utf-8"/>
    <title>Search Voyager</title>
  </head>

  <body>
    <form id="searchForm" action="http://localhost:8888">
      <input type="text" id="searchField" name="q" placeHolder="Search Voyager"/>
      <input type="button" value="Submit"/>
    </form>
  </body>
</html>

Custom Processes

Off the shelf, Voyager includes a robust processing framework which allows day-to-day tasks such as Clip and Ship, Mosaic, etc. to be automated. Extending Voyager to support new processes, tailored to your organization, is available through professional services. Contact support@voyagergis.com for more information.

Voyager REST API

Explore API

Voyager provides a REST API for developers to integrate their enterprise applications with. You can go to http://\[voyagerBaseUrl\/api/docs] and explore what end points are available. Clicking on the resource links will expand it further if there are sub-resources.

Try the API

The API Explorer has a tool for you to call the end points without having to write any code. Select the resource you want to browse, pick an operation to perform, fill in any required data and click "Try it out\!".

Using DELETE & PUT 

Developers integrating their applications with Voyager may find that their development environment cannot send an HTTP request with a verb other than GET or POST (Flash, browser forms, etc). This can be remedied by appending a URL parameter to indicate the true intention of the request.

http://localhost:7777/api/rest/list/114?_method=PUT

http://localhost:7777/api/rest/list/114?_method=DELETE

Query API

Developers can access the index via OpenSearch, RSS, Atom or access the raw solr index via Solr REST Access.

OpenSearch, RSS, Atom

Voyager supports RSS along with extensions for geospatial content (GeoRSS) and Media (MRSS). You can use the following queries to return information via RSS.

This will return the entire index:

Return content matching the text query “vegas”

Return datasets using a spatial constraint:

Return items which have a subtype of raster:

Any of these queries can be combined together. For example raster datasets which match the text query of “vegas”:

By default the georss:box element is written as 'xmin ymin xmax ymax' -- this can be in conflict to applications that expect 'lat lon lat lon'. To flip the coordinates to 'lat lon lat lon' add ?flip=true to the query string

Atom

To use the Atom format, change the URL to:

This can also be returned as json (or jsonp)

Solr REST Access

Voyager supports a REST based API which returns information as either a JSON or XML response.

The following query will return content from the index in JSON format

This query, same as above, returns information in XML format

Similar to RSS as documented above queries for spatial extent, filters and text constraints can be specified:

Text query:

Spatial extent:

Filter:

Additional parameters may also be specified.

Number of rows returned:

Specific field information (as opposed to all fields):

For example the following query will return all items matching the text query for “roads”, return only the “name” and “id” fields in JSON format limited to the first 10 records:

Once search results are returned you can query voyager for additional information such as an items thumbnail where a5594bd7ca6e257b is the ID of the item:

The ID can also be used to obtain a direct link to the detailed search result page:

The ID can be used to returned a detailed XML representation for the item:

http://localhost:8888/solr/v0/select?q=id:+[a5594bd7ca6e257b|http://localhost:8888/voyager/#/id=a5594bd7ca6e257b/]+

Supporting New Formats

Off the shelf, Voyager is capable of indexing a broad range of formats. If needed, it is possible to add new formats through a professional services engagement with VoyagerGIS. For more information please contact support@voyagergis.com.

Working With Voyager

If you are new to Voyager the following video tutorials are a great way to get started. They range from basic to more advanced topics and while they are narrated in English, these videos contain a lot of visual information that non-English speakers will find helpful. If you have ideas for a new tutorial please let us know by contacting us at support@voyagergis.com.

Find Duplicate Data

Use Voyager to locate multiple copies of the same data on your computer or throughout your organization.

Find All Data With Missing Metadata

Finding files that are missing metadata is easy with Voyager - use the "Missing Metadata" Saved Search.

More information about Saved Searches

Explore Map Documents

This video explains:

• How to filter for map documents
• Viewing data used to create the map
• How to see the layer structure within the document
• Exporting map document results into a Shapefile

Audit Broken Data

Moving or deleting map documents (.mxd or .lyr) or data files often results in links being broken between the document and the data. Use the "Items with Broken Data" Saved Search to find which links are broken.

More information about Saved Searches

Searching

Information about Text and Spatial Searching.

See also: Searching for Data

Voyager Desktop vs. Browser

Some of the few differences in using Voyager Desktop vs. using Voyager through an Internet Browser.

Clip and Ship Data

View Options

See also: Working with Views

Using Filters

Saving a Search

Export Results

Add a Location

Sorting

Indexing Status

Removing Results

Base Map Caching

Create User Accounts

User Account Configurations

Manage Locations

Text Searching

New with Voyager 1.2.3 some new text searching capabilities.

See Also: Voyager 1.2.3

Default Query Settings

See Also: Query Settings

CSW Extension

See Also: CSW Server

Change Default Settings

Steps on how to change how your default view and settings look.

Drag and Drop into ArcMap

Voyager Desktop allows users to take results and drag them right into an ArcMap Document.

Federated Search

Federated Search allows users to query multiple Voyager indexes with a single search. By linking multiple Voyager instances together users can gain access to more data, faster. There are a number of ways that federated search can benefit an organization.

Find publicly available data on the internet or in commercial libraries

In some cases locating the information that you don't have is critical to making the best decisions. To help users find this data Voyager has created a public catalog of available web services and commercial content which can be easily incorporated into daily workflows using Voyager's federated search. To connect to the preconfigured public portal simply visit Saved Searches and select "Remote Catalog Search". This will enable users to search their local catalog, Voyager's catalog of publicly available data or other catalogs that have been configured by an administrator.

Remote Catalog Saved Search

View Remote Catalog Filters

Link multiple (remote) locations together

Organizations often have offices distributed across a country or the world. In many cases bandwidth to remote sites isn't readily available or necessarily reliable making indexing of remote locations inefficient. For organizations that wish to have a single unified view of all of their data they can install Voyager at each location and then link each of the Voyager indexes together using a federated search solution.

Provide a consolidated view across multiple departments

Some organizations have a decentralized structure with many autonomous departments each maintaining their own Voyager index. For example in a state government, individual departments such as the Transportation Commission, Department of Health and Human Services, Department of Agriculture or others may have a requirement to maintain their own data and corresponding Voyager index. Yet at the state level there may be a need to provide a single unified search solution where workers are able to locate information across all departments. To satisfy all of these requirements Voyager's federated search can be used. This approach helps organizations save time and money by efficiently sharing data, leading to less duplication of effort, preventing the organization from purchasing or collecting the same data twice and in general promoting the efficient use of resources.

Recommended Configurations

Voyager applies reasonable defaults out-of-the box that should work for most situations. Here are some recommended configurations for some typical indexing setups.

Collection with many MXD or LYR files

By default, Voyager will draw thumbnails in a separate process from the indexing process. The advantage is that Voyager will index the data quickly; however it will take much longer to draw all the thumbnails.

If you know you want thumbnails for everything, be sure to disable 'Build Thumbnails in Separate Process'. When Voyager builds thumbnails in the same process as indexing, it only opens the resource once and is overall much faster.

See: Data Discovery Settings and Location Discovery Settings

Large Collection of Imagery Data

With the proper settings, Voyager can index imagery very quickly.

Log File Settings

* Make sure [Logging |DOC:Logging]is set to ERROR or WARN

Discovery Settings

* Only calculate MD5 Hash if you need to.
* Build thumbnails in the same process (typically will not matter)
* Ignore XML Metadata.
* Skip Discovery Queue

See: Data Discovery Settings and Location Discovery Settings

Voyager FAQ

How do I clear the index and start over?

See Clear Index

What is the default username / password?

admin / admin

Does Voyger Desktop support our proxy configuration?

Yes, Voyager Desktop supports configurable proxy settings.

What formats does Voyager support?

See Supported Formats

Can voyager support my custom format?

See Supporting New Formats

Why does Voyager Desktop return "Site Configuration Error" when I try to connect to  my Voyager Server?

See Voyager URL

Changelog

Voyager 1.5.3

• Improve support for UTF-8 filenames in gdal handler
• Support Drag+Drop to ArcMap 10.1

Voyager 1.5.2

• fixed Issue with German Locale

Voyager 1.5.1

• Fixed Login Issue with IE compatibility view

Voyager 1.5.0

Voyager 1.5 introduces a number of enhancements:

• Improvements to Active Directory integration including enhanced single sign-on
• New features for Dynamic Labels allows you to assign filterable tags on the fly. For example, your office might have sites spread around the world. Now you can dynamically tag any data that is within an office extent allowing users to filter data from office "Location A", "Location B" etc.
• Finer grained tuning of search result relevancy as well as the ability to boost items in the results window
• Field Value reporting allows users to export a distinct list of values from any property in the index. For example a summary of file types along with their respective counts
• New tools for developers make learning the API easier by taking any Voyager query and turning it into a REST query / response 
• New metadata user interface allowing administrators to extract values from any metadata profile using standard XPath expressions
• Important bug fixes including: better support of Norwegian character sets; better handling of localized coordinates within the ArcMap toolbar; improved search on UNC file paths and many more...

Voyager 1.4.1

Voyager 1.4.1 is a service pack release that resolves a few minor bugs and adds a couple of minor features. This includes:

• Fixed Internet Explorer landing page which caused Voyager to not be responsive on initial requests

• Extended API support adding the ability to 'flip' georss:box coordinates in feeds

• Improved custom metadata extraction to allow a meta.csv configuration file to include XPath with namespace (i.e. gmd:xxx)

• Improved indexing services to now support NaN values for extent (this previously failed)

• Adding default metadata field extraction for ESRI 10 style XML

• License page shows a link to the license on http://voyagergis.com/licenses

Voyager 1.4.0

Voyager 1.4 brings a number of changes that make it easier to integrate into your enterprise environment. This release also highlights a number of additional data formats, overview map improvements, user interface updates and customization options that allow you to tune Voyager to best suite your needs.

Expanded Security Model

Voyager's security model allows you to provide a better search experience by controlling how users search for, view and work with secure content. By seamlessly integrating with Windows Active Directory or LDAP environments Voyager allows uses to use a single sign-on removing the need for redundant logins. If you prefer to not use Windows Authentication or LDAP you can also choose from an expanded internal authentication model which offeres finer grained access control.

New Language Support

To best support our international users we have added language support for:

• Portuguese
• Thai

Supported Formats

Office Formats

• Microsoft Word \*.doc, \*.docx
• Microsoft PowerPoint \*.ppt, \*.pptx
• Microsoft Excel \*.xls, \*.xlsx
• Microsoft Visio \*.vsd 
• Microsoft Mail \*.msg
• Microsoft Office Publisher \*.pub
• Rich Text Format \*.rtf document

Geospatial formats

• FMW - FME Workbench files.
• JPEG 2000 files are now supported through our GDAL based indexing framework

Mapping

• Web Mercator coordinate system is now supported allowing Voyager users to better leverage mapping services by popular content providers such as Google Maps and ESRI ArcGIS Online.
• Improved support for Google Maps

Administrative Improvements

• Password reset allows you to reset an administrative password using Command Line Options.
• Hosting of thumbnails, XML metadata, Esri Layer (lyr) and other meta files on a remote server  such as Amazon S3, Rackspace etc. This greatly improves the flexibility for cloud based deployment of Voyager instances.

Voyager 1.3.1

Lidar Data Support

Voyager can now automatically discover and serve large collections of Lidar data in either LAS or LAZ formats. 

Custom Metadata Extraction

Voyager can now be configured to extract specific pieces of metadata during indexing. Metadata profiles or custom metadata fields can then be used in reporting, sorting and filtering data as it comes into the system.

Search for Any File Type

Voyager now supports basic indexing of any file type. This includes the ability to search by file name, path, size, file extension and last modified time. It even supports duplicate detection\!

Work without ArcGIS

Index a wide variety of formats without having to install ArcGIS. \*See tip below

Overview Map Improvements

The overview map has also been improved:

• Added Spherical Mercator projections
• Updated to latest Google maps APIs
• Implemented Esri's latest street as the default map service

Configure Your User Interface

Configuring the user interface is even easier\! With a search dialog box you can quickly find fields used on the configuration pages. This will help save time by quickly customizing the information displayed in filters, the details page, and the summary views.

Chinese Language Support

Voyager is now translated into seven languages: English, German, Spanish, French, Swedish, Dutch and our newest language Chinese\!

Performance Improvements: Indexing and Duplicate Detection

We've made dramatic performance improvements when indexing hundreds-of-thousands to millions of small files. And duplicate detection significantly faster.

Proxy Setttings

Voyager Desktop now supports configurable proxy settings.

Voyager 1.3.0

Support for Federated Search

Federated Search allows users to query multiple Voyager indexes with a single search.

For example, an organization might have a corporate office in one location but satellite offices scattered across the country or around the world. Using federated search the organization would install Voyager at each location and then link the indexes together allowing users to locate any of an organizations resources using a single search.

Synonyms

Query Synonyms improve search results by returning items which maybe similar to a word or phrase but not an exact match. For instance, a search for UK might better match United Kingdom; roads might also consider highways and motorways or perhaps the American and British English spelling of Aluminium vs. Aluminum.

Improved Spatial Index

In this release we’ve taken what we've learned and have applied a new approach to spatial search. While not immediately noticeable to an end-user this allows Voyager to use considerably less system memory and therefore helps scale Voyager without requiring additional hardware.

Enhancements to ArcGIS Server and WMS Indexing

Indexing of web mapping services is now significantly faster and much more thorough. We've also added new views which highlight the relationship between map servers and the services that they contain. For example it is easy to all of the services which a server contains as well as filter and query for services that meet specific criteria for example use spatial search and filers to find: map services for a given area which support the 'find' and 'identify' operations as well as use the WGS 1984 Web Mercator projection.

Index of Publicly Available Web Map Services

Use the Free on-line instance of Voyager to find publicly available ArcGIS server and WMS services. This public Voyager instance can be used directly via a web browser (http://demo.voyagergis.com/services) or through Voyager's federated search to provide a single search solution across local and publicly available content. Note: If you have services that you would like to see added to the on-line catalog please let us know at: info@voyagergis.com.

Streamlined Software Authorization and License Management

We've updated the license management process so that it's easy to manage and self-issue software licenses on-line. Upgrading to the 1.3 release will require a new software license. Visit http://voyagergis.com/licenses to manage your licenses or email support@voyagergis.com to request a new license.

Improved PDF Indexing

Some PDF indexing times will be significantly faster in 1.3.0

Voyager 1.2.3

Voyager 1.2.3 contains new features which work together to increase your ability to find information, share data with others, provides support for new formats and improve overall productivity.

Enhanced Search

Voyager's query syntax has been improved to support better text search. This includes:

• Support for AND, OR, quotes and other text syntax
• Improvements to range queries
• Support for wild cards and partial word matches
• Special query parser for handling file system paths

See Also: Text Searching

Tools for tuning search relevancy

New tools are available for tuning search result relevancy, including settings for:

• Determining which fields are used in calculating text search relevancy
• Ability to boost ranking terms by configuring the importance of any part of a query relative to the other parts. For example text found in a document's name (title) may be more important than text found in its body.
• Determining how search results should be ordered when a query has not been specified. This is typically used to promote highlighted items to the top of the page when a query has not been specified.

See Also: Query Settings

CSW Metadata Repository

Voyager implements the OGC Catalog Service for the Web (CSW) server technology which can be used to deliver an OGC-based Metadata Repository based on content within Voyager's index.

Role Based Access Control

Role based security settings allow you to control the types of data that a person can access. Examples might include allowing users to only view items with metadata or to only view content from specific server locations.

See Also: Access

New interface and query syntax for working with file system paths

Folder naming conventions and directory structure is often an important aspect of organizing information. Voyager now supports the ability to easily refine search results to content in specific file system locations. To do this a user can either click and drag over a file system path in the Voyager user interface (thereby creating a filter based on the selected location) or by entering the location directly into the text search dialog ("path=
gisserver\data\project-y)

Support for new formats

• PCI Geomatix (.pix)
• CSW
• Geosoft Grid

Voyager 1.2.2

Internationalization and Localization

We are excited about the interest in Voyager and the number of people using it across the world. To better support our international customers we have made a number of improvements for adapting Voyager to different languages, regional differences and the technical requirements of various languages. Version 1.2.2 now supports the following languages:

• English
• German
• Spanish
• French
• Swedish
• Dutch

Report View

A new reporting view that generates graphs based on the configurable set of filters used to narrow search results. Graphs include pie and bar charts, are interactive and will work in any web browser (without the need for special plug-ins such as Flash or Silverlight).

New Processing Framework Tasks

Voyager’s processing framework allows users to take selected search results and then run them through a process such as mosaicing imagery, extracting data through clip-n-ship functionality and more. The 1.2.2 release adds new tasks for creating ESRI Mosaic Datasets as well as GeoPDF documents.

Indexing Open Geospatial Consortium Catalog Services (CSW)

With Voyager users can now query CSW compliant servers by simply adding the server URLs to Voyager’s list of Discovery Locations. Once configured Voyager will index the CSW service and contents will then become searchable from within Voyager through text queries, spatial extent and filters.

Indexing Improvements and other bug fixes

• Added support for ArcGIS Server Image Services
• Improved indexing datasets and ESRI Map Documents allowing useful questions such as “What dataset does this document use” and “What documents use this dataset”
• A number of general bug fixes geared toward improving the user interface and performance

Voyager 1.2.1

Performance Improvements and Bug Fixes

The main goal of the 1.2.1 release, following shortly after the 1.2 release, is to improve the performance of the newly redesigned Data Discovery framework and to fix any outstanding bugs with the new indexing framework and other parts of Voyager. A few key areas that have been significantly improved:

• Faster discovery for SDE databases, especially those with many feature datasets
• Improved discovery performance and stability for MXDs and Layer Files
• Stabilized discovery and improved thumbnails for PDF and MapInfo/E00
• Using faster GDAL indexing for A.TOC

Improved Documentation

The other main focus for the 1.2.1 release is improving our documentation.  We've updated the Getting Started Guide and System Reference, including more detailed information on Voyager configuration and management, so you can learn how to configure your Voyager instance to specifically meet your needs.  We've also added links to the documentation from the Voyager Help page and from the Configuration Manager during installation, so you can easily find the help you need.

Improved User Interface

The user interface continues to evolve with some of the following new and updated features:

• Watch a discovery location for changes, and immediately see the changes in your Voyager index.
  
  
  
• Links from MXD or Layer File documents directly to the contained data sources
  
  

New Formats

The following new formats are supported:

• GP tool properties

Voyager 1.2.0

Redesigned Data Discovery

The most significant feature of the 1.2 release is a completely rewritten indexing framework. We’ve taken what we’ve learned and applied it so that you can quickly view and start using your data faster. The new framework features intelligent indexing modules that are tailored to various types of data. This allows us to use the best possible indexing tool for the task at hand. Additionally, it’s very easy to add new formats via plug-in modules.

Finer control over Data Discovery processes

As part of the indexing redesign we’ve added far greater control to how data is indexed. You now have finer-grained control over starting and stopping the indexing queue, how thumbnails are generated and many other configuration tasks.

Improved User Interface

The user interface continues to evolve with some of the following new and updated features:

• New way to display links between items.  This allows you to easily see which layers and data sources are used by a Map Document or Layer File or which data sources are within a database.

The links also provide a clear way to view the data that is contained within a database or feature dataset

• Improved Map display and basemap caching options
• Added ‘check’ style filtering to enable “OR” queries

New Formats

The following new formats are supported:

• KML
• MapInfo TAB, MIF
• ESRI Geoprocessing toolbox, tools and python scripts
• ESRI E00 (Arc/Info interchange format)
• RPF – over 50 new raster product format file types are now supported

ArcGIS 10

ArcGIS 10 is now fully supported

ArcGIS Desktop Integration

This release introduces a new ArcMap toolbar that allows you to search the voyager index using text and spatial queries as well as drag-and-drop search results from Voyager Desktop to ArcMap. ArcMap integration works on ArcGIS 9.2, 9.3, 9.3.1 and ArcGIS 10

Voyager 1.1.0

Updated User Interface

An enhanced user interface featuring context sensitive menu systems, map centric views, better list management, intelligent filters and a more intuitive configuration interface is introduced in Version 1.1.

Newly Supported Formats

Voyager now supports additional spatial formats including geo-tagged photos, geo-pdf, gpx files and new raster formats.  Version 1.1 also introduces support for office formats including: Microsoft Word, Power Point and PDF. In addition to newly supported formats, performance on existing formats has been significantly improved.

Redesigned Processing Framework

Voyager now includes a redesigned processing framework that allows users to run individual items, a list of items or entire result sets through a configurable set of processing tasks. Processes range from opening items with an application (ArcMap, ArcCatalog) to editing metadata, converting to KML, clip-n-ship data extraction.

Version 1.1includes a broad collection of tasks and others can be added easily to help automate processes and streamline daily work.

Administration

Voyager’s administration interface has been significantly amended to include a scheduler for when data discovery should run, filters to include or exclude types of data from being added to the Voyager index, and flexible timeout values to limit the amount of time spent indexing certain data types.

The administration interface now allows users greater control when configuring the number of discovery and thumbnail creation threads, monitoring progress and many other aspects of tailoring voyager to an organizations needs, including managing security.

Support for Off-line Overview Map

Version 1.1 supports an off-line base map capability for organizations that need to deploy Voyager where web based map servers are not available. For instance on laptops deployed to the field where Internet access is not readily available.

Upgrades

Follow the migration guides to upgrade from one version to the next.

Upgrading to 1.5.0 from 1.4.1

Upgrading to 1.5.0 from 1.4.1 does not require any special steps. Simply shutdown Voyager, install on top of 1.4.1 and then restart.

Upgrading to 1.4.1 from 1.4.0

Upgrading to 1.4.1 from 1.4.0 does not require any special steps. Simply shutdown Voyager, install on top of 1.4.0 and then restart.

Upgrading to 1.4.0 from 1.3.1

Importing 1.3.x Data

The 1.4.x index format is not compatible with 1.3.x.but we have a tool to import the 1.3.x index into 1.4.

1. Shutdown Voyager 1.3.x

2. Download and install Voyager 1.4.x. This will pick a default install directory: C:/voyager/voyager_1.4

3. Do not start voyager in the last step

4. Edit the Voyager.vmoptions file, point the data.dir path to your existing data.dir: -Ddata.dir=C:/voyager/path/to/data (maybe: c:\voyager\voyager_1.3\data)

4. Start voyager and the browser should automatically go to http://localhost:8888/setup/import.

5. Locate the 1.3.x data.dir directory and click import.

6. If successful, you should receive a confirmation message

Upgrading to 1.3.1 from 1.3.0

Upgrading to 1.3.1 from 1.3.0 does not require any special steps. Simply shutdown Voyager, install on top of 1.3.0 and then restart.

Upgrading to 1.3.0 from 1.2.x

Voyager 1.3 uses an index format that is incompatible with previous Voyager releases. To update simply follow one of the following steps:

Install Voyager 1.3 and start from scratch

1. Install Voyager 1.3 into a new location
2. Reconfigure your data discovery locations and reindex your data

Reuse existing Voyager configuration

1. Install Voyager 1.3 into a new location
2. Reuse existing thumbnails and configuration properties by setting the data directory folder using the Voyager.vmoptions file (i.e. \-Ddata.dir=/path/to/existing/data/directory/)
3. Restart Voyager.  When you restart, Voyager will attempt to use the 1.2.x license from the previous data directory and display a warning stating "This appears to be a 1.2.x license. To request a new license, visit http://voyagergis.com/licenses". To continue, simply re-enter your 1.3 license and click "Install License".
4. Reindex your data either by queuing each location individually or going to /manage/discovery/status and click "Queue All Locations". This will leverage the new index structure while re-using existing thumbnails, layer files and other properties, speeding up the reindexing process.

Software Licenses

Upgrading to the 1.3 release will require a new software license. Visit http://voyagergis.com/licenses to manage your licenses or send an e-mail to support@voyagergis,com to request a new license.

Upgrading to 1.2.3

Customers with current maintenance/support are entitled to upgrade to the latest version of Voyager. To do so you can simply install Voyager 1.2.3 into the same location as the previous version of Voyager. Once installed on top of an existing installation, Voyager will automatically rebuild the index and create an archive of the original index. Once completed Voyager will be available for use.

Changes in the UI

"Clear Index" option moved

Before 1.2.3, the option to Clear Index was accessed from

in 1.2.3+, it is avaliable from:

Glossary

Installation Folder

This is the directory voyager is installed

By default, it is typically:

data.dir

This is the directory where most data is stored.

By default, it is typically:

When discussing configuration and settings, we often refere to "${data.dir}" to mean this folder

vmoptions

VM options are options sent to the the Java Virtual Machine (JVM). For more details, see: Voyager.vmoptions